Skip to content

Creating a new Time Entry

Request

Creates time entries for a user.

Bulk Create

This endpoint supports bulk creating up to 100 objects. In the request body, set the top-level key to its plural form and place the objects in an array. Example:

{
  "time_entries": [
    {
      "workspace_id": 123,
      "date_performed": "2025-01-23",
      "time_in_minutes": 60
    },
    {
      "workspace_id": 123,
      "date_performed": "2025-01-24",
      "time_in_minutes": 60
    }
  ]
}

This endpoint returns structured Time Entry objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the time_entries top-level JSON key. Please see our Response Format section for more information.

Query
includestring

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • active_submission (TimesheetSubmission) - Retrieves the active timesheet (i.e. approved or pending) the time entry was submitted on, if any. The response will include active_submission_id, which references the data in the timesheet_submissions top-level key.
  • external_references (ExternalReference) - Includes references to external integrations for this object.
  • invoice (Invoice) - Retrieves the invoice the time entry was added to, if any. The response will include invoice_id, which references the data in the invoices top-level key.
  • recent_submission (TimesheetSubmission) - Retrieves the most recent timesheet the time entry was submitted on, if any, including any rejected or cancelled timesheets. The response will include recent_submission_id, which references the data in the timesheet_submissions top-level key.
  • role (Role) - Retrieves the project role of the user who performed the work for the time entry, if any. The response will include role_id, which references the data in the roles top-level key.
  • story (Story) - Retrieves the task the time entry is tracked to, if any. The response will include story_id, which references the data in the stories top-level key.
  • user (User) - Retrieves the user the time entry belongs to. The response will include user_id, which references the data in the users top-level key.
  • workspace (Workspace) - Retrieves the project the time entry is tracked to. The response will include workspace_id, which references the data in the workspaces top-level key.
optional_fieldsArray of strings

Allows you to request one or more optional fields as an array.

Items Enum:"location_id""user_can_edit"
Bodyapplication/jsonrequired
time_entryobject
{ "time_entry": { "workspace_id": 0, "date_performed": "2019-08-24", "time_in_minutes": 0, "billable": true, "rate_in_cents": 0, "notes": "string", "role_id": 0, "story_id": 0, "user_id": 0, "external_reference": { "service_name": "string", "service_model": "string", "service_model_ref": "string", "status": "string", "external_message": "string", "external_link": "string", "external_status": "string", "locked": true }, "location": "string" } }

Responses

Time Entry has been created.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
time_entriesobject
external_referencesobject
storiesobject
workspacesobject
usersobject
timesheet_submissionsobject
invoicesobject
rolesobject
Response
{ "count": 0, "meta": { "count": 0, "page_count": 0, "page_number": 0, "page_size": 0 }, "results": [ { "key": "string", "id": "string" } ], "time_entries": { "property1": { "active_submission_id": "string", "approved": true, "billable": true, "cost_rate_in_cents": 0, "created_at": "2019-08-24T14:15:22Z", "currency": "string", "currency_base_unit": 0, "currency_symbol": "string", "date_performed": "2019-08-24", "external_reference_ids": [ "string" ], "invoice_id": "string", "is_invoiced": true, "location": "string", "location_id": 0, "notes": "string", "rate_in_cents": 0, "recent_submission_id": "string", "role_id": "string", "story_id": "string", "taxable": true, "time_in_minutes": 0, "updated_at": "2019-08-24T14:15:22Z", "user_can_edit": true, "user_id": "string", "workspace_id": "string" }, "property2": { "active_submission_id": "string", "approved": true, "billable": true, "cost_rate_in_cents": 0, "created_at": "2019-08-24T14:15:22Z", "currency": "string", "currency_base_unit": 0, "currency_symbol": "string", "date_performed": "2019-08-24", "external_reference_ids": [ "string" ], "invoice_id": "string", "is_invoiced": true, "location": "string", "location_id": 0, "notes": "string", "rate_in_cents": 0, "recent_submission_id": "string", "role_id": "string", "story_id": "string", "taxable": true, "time_in_minutes": 0, "updated_at": "2019-08-24T14:15:22Z", "user_can_edit": true, "user_id": "string", "workspace_id": "string" } }, "external_references": { "property1": { "created_at": "2019-08-24T14:15:22Z", "external_link": "string", "external_message": "string", "external_status": "string", "last_synced_at": "2019-08-24T14:15:22Z", "locked": true, "service_model": "string", "service_model_ref": "string", "service_name": "string", "status": "string", "subject_id": 0, "subject_ref": { "key": "string", "id": "string" }, "subject_type": "string", "updated_at": "2019-08-24T14:15:22Z" }, "property2": { "created_at": "2019-08-24T14:15:22Z", "external_link": "string", "external_message": "string", "external_status": "string", "last_synced_at": "2019-08-24T14:15:22Z", "locked": true, "service_model": "string", "service_model_ref": "string", "service_name": "string", "status": "string", "subject_id": 0, "subject_ref": { "key": "string", "id": "string" }, "subject_type": "string", "updated_at": "2019-08-24T14:15:22Z" } }, "stories": { "property1": { "ancestor_ids": [ "string" ], "ancestry_depth": 0, "archived": true, "archived_editable": true, "assigned_role_id": "string", "assignee_ids": [ "string" ], "assignment_timestamped_at": "2019-08-24T14:15:22Z", "attachment_ids": [ "string" ], "billable": true, "budget_estimate_in_cents": 0, "budget_used_in_cents": 0, "can_align_time": true, "can_edit": true, "can_post": true, "created_at": "2019-08-24T14:15:22Z", "creator_id": "string", "current_assignment_ids": [ "string" ], "custom_field_value_ids": [ "string" ], "custom_task_status_id": 0, "deleted_at": "2019-08-24T14:15:22Z", "descendant_ids": [ "string" ], "description": "string", "due_date": "2019-08-24", "external_reference_ids": [ "string" ], "fixed_fee": true, "follower_ids": [ "string" ], "formatted_description": "string", "google_document_ids": [ "string" ], "has_out_of_bounds_sads": true, "invoiced_balance_in_cents": 0, "is_time_trackable_type": true, "logged_billable_time_in_minutes": 0, "logged_nonbillable_time_in_minutes": 0, "parent_id": "string", "parsed_description": "string", "percentage_complete": 0, "position": 0, "potential_workspace_resource_ids": [ "string" ], "potential_workspace_resources_with_unnamed_ids": [ "string" ], "priority": 0, "project_plan": true, "read_only": true, "render_description_markdown": true, "reply_ids": [ "string" ], "root_id": "string", "source_dependency_ids": [ "string" ], "start_date": "2019-08-24", "state": "string", "status": "string", "story_state_change_ids": [ "string" ], "story_task_ids": [ "string" ], "story_type": "string", "sub_stories_billable_time_in_minutes": 0, "sub_stories_budget_estimate_in_cents": 0, "sub_stories_budget_used_in_cents": 0, "sub_stories_time_estimate_in_minutes": 0, "sub_story_count": 0, "sub_story_ids": [ "string" ], "subtree_depth": 0, "tag_ids": [ "string" ], "target_dependency_ids": [ "string" ], "time_estimate_in_minutes": 0, "time_trackable": true, "title": "string", "uninvoiced_balance_in_cents": 0, "updated_at": "2019-08-24T14:15:22Z", "weight": 0, "workspace_id": "string", "workspace_resource_ids": [ "string" ], "workspace_resources_with_unnamed_ids": [ "string" ] }, "property2": { "ancestor_ids": [ "string" ], "ancestry_depth": 0, "archived": true, "archived_editable": true, "assigned_role_id": "string", "assignee_ids": [ "string" ], "assignment_timestamped_at": "2019-08-24T14:15:22Z", "attachment_ids": [ "string" ], "billable": true, "budget_estimate_in_cents": 0, "budget_used_in_cents": 0, "can_align_time": true, "can_edit": true, "can_post": true, "created_at": "2019-08-24T14:15:22Z", "creator_id": "string", "current_assignment_ids": [ "string" ], "custom_field_value_ids": [ "string" ], "custom_task_status_id": 0, "deleted_at": "2019-08-24T14:15:22Z", "descendant_ids": [ "string" ], "description": "string", "due_date": "2019-08-24", "external_reference_ids": [ "string" ], "fixed_fee": true, "follower_ids": [ "string" ], "formatted_description": "string", "google_document_ids": [ "string" ], "has_out_of_bounds_sads": true, "invoiced_balance_in_cents": 0, "is_time_trackable_type": true, "logged_billable_time_in_minutes": 0, "logged_nonbillable_time_in_minutes": 0, "parent_id": "string", "parsed_description": "string", "percentage_complete": 0, "position": 0, "potential_workspace_resource_ids": [ "string" ], "potential_workspace_resources_with_unnamed_ids": [ "string" ], "priority": 0, "project_plan": true, "read_only": true, "render_description_markdown": true, "reply_ids": [ "string" ], "root_id": "string", "source_dependency_ids": [ "string" ], "start_date": "2019-08-24", "state": "string", "status": "string", "story_state_change_ids": [ "string" ], "story_task_ids": [ "string" ], "story_type": "string", "sub_stories_billable_time_in_minutes": 0, "sub_stories_budget_estimate_in_cents": 0, "sub_stories_budget_used_in_cents": 0, "sub_stories_time_estimate_in_minutes": 0, "sub_story_count": 0, "sub_story_ids": [ "string" ], "subtree_depth": 0, "tag_ids": [ "string" ], "target_dependency_ids": [ "string" ], "time_estimate_in_minutes": 0, "time_trackable": true, "title": "string", "uninvoiced_balance_in_cents": 0, "updated_at": "2019-08-24T14:15:22Z", "weight": 0, "workspace_id": "string", "workspace_resource_ids": [ "string" ], "workspace_resources_with_unnamed_ids": [ "string" ] } }, "workspaces": { "property1": { "access_level": "string", "account_color_id": "string", "account_id": 0, "account_insights_mapping_ids": [ "string" ], "actual_fees_includes_additional_line_items": true, "actual_fees_includes_expenses": true, "approver_id": "string", "approver_ids": [ "string" ], "archived": true, "billable_minutes": 0, "billing_milestone_ids": [ "string" ], "budget_remaining": "string", "budget_used": "string", "budget_used_in_cents": 0, "budgeted": true, "can_create_line_items": true, "can_invite": true, "change_orders_enabled": true, "client_lead_name": "string", "client_role_name": "string", "consultant_role_name": "string", "created_at": "2019-08-24T14:15:22Z", "creator_id": "string", "currency": "string", "currency_base_unit": 0, "currency_symbol": "string", "current_status_report_id": "string", "current_user_participation_id": "string", "custom_field_value_ids": [ "string" ], "default_rate": "string", "description": "string", "due_date": "2019-08-24", "effective_due_date": "2019-08-24", "estimated_minutes": 0, "exclude_archived_stories_percent_complete": true, "expenses_in_burn_rate": true, "external_link": { "url": "string", "text": "string" }, "external_reference_ids": [ "string" ], "financial_viewer_ids": [ "string" ], "has_active_expense_report_submissions": true, "has_active_timesheet_submissions": true, "has_budget_access": true, "incoming_email_address": "string", "lock_date": "2019-08-24", "minutes_logged": 0, "next_uncompleted_milestone_id": "string", "non_billable_minutes": 0, "over_budget": true, "participant_ids": [ "string" ], "participation_ids": [ "string" ], "percent_of_budget_used": 0, "percentage_complete": 0, "permissions": { "can_upload_files": true, "can_private_message": true, "can_join": true, "is_participant": true, "access_level": "string", "team_lead": true, "user_is_client": true, "can_change_price": true, "can_change_story_billable": true, "can_post": true, "can_edit": true, "restricted": true, "can_see_financials": true, "is_guest_on_project": true }, "possible_approver_ids": [ "string" ], "posts_require_privacy_decision": true, "price": "string", "price_in_cents": 0, "primary_counterpart_id": "string", "primary_maven_id": "string", "primary_workspace_group_id": "string", "provider_lead_name": "string", "rate_card_id": 0, "require_expense_approvals": true, "require_notes_on_time_entries": true, "require_time_approvals": true, "revenue_recognition_method_id": "string", "revenue_recognition_method_name": "string", "stage": "string", "start_date": "2019-08-24", "status": { "color": "string", "key": "string", "message": "string" }, "status_report_ids": [ "string" ], "stories_are_fixed_fee_by_default": true, "target_margin": 0.1, "task_status_set_id": "string", "task_status_set_name": "string", "task_statuses": [ "string" ], "tasks_default_non_billable": true, "time_trackable": true, "timesheet_submission_ids": [ "string" ], "title": "string", "total_expenses_in_cents": 0, "total_invoiced": "string", "total_minutes_approved": 0, "updated_at": "2019-08-24T14:15:22Z", "workspace_group_ids": [ "string" ], "workspace_invoice_preference_id": 0, "workspace_resource_ids": [ "string" ], "workspace_resources_with_unnamed_ids": [ "string" ] }, "property2": { "access_level": "string", "account_color_id": "string", "account_id": 0, "account_insights_mapping_ids": [ "string" ], "actual_fees_includes_additional_line_items": true, "actual_fees_includes_expenses": true, "approver_id": "string", "approver_ids": [ "string" ], "archived": true, "billable_minutes": 0, "billing_milestone_ids": [ "string" ], "budget_remaining": "string", "budget_used": "string", "budget_used_in_cents": 0, "budgeted": true, "can_create_line_items": true, "can_invite": true, "change_orders_enabled": true, "client_lead_name": "string", "client_role_name": "string", "consultant_role_name": "string", "created_at": "2019-08-24T14:15:22Z", "creator_id": "string", "currency": "string", "currency_base_unit": 0, "currency_symbol": "string", "current_status_report_id": "string", "current_user_participation_id": "string", "custom_field_value_ids": [ "string" ], "default_rate": "string", "description": "string", "due_date": "2019-08-24", "effective_due_date": "2019-08-24", "estimated_minutes": 0, "exclude_archived_stories_percent_complete": true, "expenses_in_burn_rate": true, "external_link": { "url": "string", "text": "string" }, "external_reference_ids": [ "string" ], "financial_viewer_ids": [ "string" ], "has_active_expense_report_submissions": true, "has_active_timesheet_submissions": true, "has_budget_access": true, "incoming_email_address": "string", "lock_date": "2019-08-24", "minutes_logged": 0, "next_uncompleted_milestone_id": "string", "non_billable_minutes": 0, "over_budget": true, "participant_ids": [ "string" ], "participation_ids": [ "string" ], "percent_of_budget_used": 0, "percentage_complete": 0, "permissions": { "can_upload_files": true, "can_private_message": true, "can_join": true, "is_participant": true, "access_level": "string", "team_lead": true, "user_is_client": true, "can_change_price": true, "can_change_story_billable": true, "can_post": true, "can_edit": true, "restricted": true, "can_see_financials": true, "is_guest_on_project": true }, "possible_approver_ids": [ "string" ], "posts_require_privacy_decision": true, "price": "string", "price_in_cents": 0, "primary_counterpart_id": "string", "primary_maven_id": "string", "primary_workspace_group_id": "string", "provider_lead_name": "string", "rate_card_id": 0, "require_expense_approvals": true, "require_notes_on_time_entries": true, "require_time_approvals": true, "revenue_recognition_method_id": "string", "revenue_recognition_method_name": "string", "stage": "string", "start_date": "2019-08-24", "status": { "color": "string", "key": "string", "message": "string" }, "status_report_ids": [ "string" ], "stories_are_fixed_fee_by_default": true, "target_margin": 0.1, "task_status_set_id": "string", "task_status_set_name": "string", "task_statuses": [ "string" ], "tasks_default_non_billable": true, "time_trackable": true, "timesheet_submission_ids": [ "string" ], "title": "string", "total_expenses_in_cents": 0, "total_invoiced": "string", "total_minutes_approved": 0, "updated_at": "2019-08-24T14:15:22Z", "workspace_group_ids": [ "string" ], "workspace_invoice_preference_id": 0, "workspace_resource_ids": [ "string" ], "workspace_resources_with_unnamed_ids": [ "string" ] } }, "users": { "property1": { "abbreviated_timezone": "string", "account_membership_id": "string", "bio": "string", "city": "string", "classification": "string", "country": "string", "custom_field_value_ids": [ "string" ], "email_address": "string", "external_reference_ids": [ "string" ], "full_name": "string", "headline": "string", "last_site_activity": "2019-08-24T14:15:22Z", "manager_id": "string", "photo_path": "string", "role_id": "string", "skill_ids": [ "string" ], "skill_membership_ids": [ "string" ], "state": "string", "website": "string", "work_sample_ids": [ "string" ] }, "property2": { "abbreviated_timezone": "string", "account_membership_id": "string", "bio": "string", "city": "string", "classification": "string", "country": "string", "custom_field_value_ids": [ "string" ], "email_address": "string", "external_reference_ids": [ "string" ], "full_name": "string", "headline": "string", "last_site_activity": "2019-08-24T14:15:22Z", "manager_id": "string", "photo_path": "string", "role_id": "string", "skill_ids": [ "string" ], "skill_membership_ids": [ "string" ], "state": "string", "website": "string", "work_sample_ids": [ "string" ] } }, "timesheet_submissions": { "property1": { "comment": "string", "created_at": "2019-08-24T14:15:22Z", "currency": "string", "currency_base_unit": 0, "currency_symbol": "string", "current_resolution_created_at_date": "2019-08-24T14:15:22Z", "current_resolution_creator_id": 0, "current_resolution_description": "string", "end_date": "2019-08-24", "external_reference_ids": [ "string" ], "line_item_total_formatted": "string", "line_item_total_in_cents": 0, "permissions": { "can_cancel_submission": true, "can_approve_submission": true, "can_reject_submission": true, "can_resubmit_submission": true }, "resolution_description": "string", "start_date": "2019-08-24", "status": "string", "time_entry_ids": [ "string" ], "title": "string", "type": "string", "updated_at": "2019-08-24T14:15:22Z", "user_id": "string", "workspace_id": "string" }, "property2": { "comment": "string", "created_at": "2019-08-24T14:15:22Z", "currency": "string", "currency_base_unit": 0, "currency_symbol": "string", "current_resolution_created_at_date": "2019-08-24T14:15:22Z", "current_resolution_creator_id": 0, "current_resolution_description": "string", "end_date": "2019-08-24", "external_reference_ids": [ "string" ], "line_item_total_formatted": "string", "line_item_total_in_cents": 0, "permissions": { "can_cancel_submission": true, "can_approve_submission": true, "can_reject_submission": true, "can_resubmit_submission": true }, "resolution_description": "string", "start_date": "2019-08-24", "status": "string", "time_entry_ids": [ "string" ], "title": "string", "type": "string", "updated_at": "2019-08-24T14:15:22Z", "user_id": "string", "workspace_id": "string" } }, "invoices": { "property1": { "additional_item_ids": [ "string" ], "balance_in_cents": 0, "billing_milestone_ids": [ "string" ], "created_at": "2019-08-24T14:15:22Z", "currency": "string", "currency_base_unit": 0, "currency_symbol": "string", "draft": true, "due_date": "2019-08-24", "expense_ids": [ "string" ], "external_reference_ids": [ "string" ], "fixed_fee_item_ids": [ "string" ], "invoice_date": "2019-08-24", "message": "string", "payment_schedule": 0, "project_code": "string", "purchase_order": "string", "recipient_id": "string", "status": "string", "tax_rate": 0.1, "time_entry_ids": [ "string" ], "title": "string", "updated_at": "2019-08-24T14:15:22Z", "user_id": "string", "user_invoice_number": 0, "user_invoice_title": "string", "workspace_ids": [ "string" ] }, "property2": { "additional_item_ids": [ "string" ], "balance_in_cents": 0, "billing_milestone_ids": [ "string" ], "created_at": "2019-08-24T14:15:22Z", "currency": "string", "currency_base_unit": 0, "currency_symbol": "string", "draft": true, "due_date": "2019-08-24", "expense_ids": [ "string" ], "external_reference_ids": [ "string" ], "fixed_fee_item_ids": [ "string" ], "invoice_date": "2019-08-24", "message": "string", "payment_schedule": 0, "project_code": "string", "purchase_order": "string", "recipient_id": "string", "status": "string", "tax_rate": 0.1, "time_entry_ids": [ "string" ], "title": "string", "updated_at": "2019-08-24T14:15:22Z", "user_id": "string", "user_invoice_number": 0, "user_invoice_title": "string", "workspace_ids": [ "string" ] } }, "roles": { "property1": { "created_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "external_reference_ids": [ "string" ], "name": "string", "updated_at": "2019-08-24T14:15:22Z" }, "property2": { "created_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "external_reference_ids": [ "string" ], "name": "string", "updated_at": "2019-08-24T14:15:22Z" } } }